Document GtkDialogFlags and GtkResponseType.

2004-10-11  Matthias Clasen  <mclasen@redhat.com>

	* gtk/tmpl/gtkdialog.sgml: Document GtkDialogFlags and GtkResponseType.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index a5a053cfeeee9e2a7689f1ddce7031f1385d7c3a..f5c19bdfa49474b4e9b671a8a5c74ad6b8545b8a 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,7 @@
 2004-10-11  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/tmpl/gtkdialog.sgml: Document GtkDialogFlags and GtkResponseType.
+
        * gtk/tmpl/gtktreesortable.sgml: Document GtkTreeIterCompareFunc
        (#154943)
 

diff --git a/docs/reference/gtk/tmpl/gtkdialog.sgml b/docs/reference/gtk/tmpl/gtkdialog.sgml
index c9d2bf157950ebf370b515f67938faec42e79339..e2fa9f0b0cc67e357f283480dfa0890c3f14c090 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkdialog.sgml
+++ b/docs/reference/gtk/tmpl/gtkdialog.sgml
@@ -51,8 +51,8 @@ gtk_dialog_add_action_widget(), clicking the button will emit a signal called
 "response" with a response ID that you specified. GTK+ will never assign a
 meaning to positive response IDs; these are entirely user-defined. But for
 convenience, you can use the response IDs in the #GtkResponseType enumeration
-(these all have values less than zero). If a dialog receives a delete event, the
-"response" signal will be emitted with a response ID of #GTK_RESPONSE_NONE.
+(these all have values less than zero). If a dialog receives a delete event, 
+the "response" signal will be emitted with a response ID of #GTK_RESPONSE_DELETE_EVENT.
 </para>
 
 
@@ -180,29 +180,35 @@ was clicked.
 
 <!-- ##### ENUM GtkDialogFlags ##### -->
 <para>
-
+Flags used to influence dialog construction.
 </para>
 
-@GTK_DIALOG_MODAL: 
-@GTK_DIALOG_DESTROY_WITH_PARENT: 
-@GTK_DIALOG_NO_SEPARATOR: 
+@GTK_DIALOG_MODAL: Make the constructed dialog modal, 
+  see gtk_widget_set_modal().
+@GTK_DIALOG_DESTROY_WITH_PARENT: Destroy the dialog when its
+  parent is destroyed, see gtk_window_set_destroy_with_parent().
+@GTK_DIALOG_NO_SEPARATOR: Don't put a separator between the
+  action area and the dialog content.
 
 <!-- ##### ENUM GtkResponseType ##### -->
 <para>
-
+Predefined values for use as response ids in gtk_dialog_add_button().
+All predefined values are negative, GTK+ leaves positive values for
+application-defined response ids. 
 </para>
 
-@GTK_RESPONSE_NONE: 
-@GTK_RESPONSE_REJECT: 
-@GTK_RESPONSE_ACCEPT: 
-@GTK_RESPONSE_DELETE_EVENT: 
-@GTK_RESPONSE_OK: 
-@GTK_RESPONSE_CANCEL: 
-@GTK_RESPONSE_CLOSE: 
-@GTK_RESPONSE_YES: 
-@GTK_RESPONSE_NO: 
-@GTK_RESPONSE_APPLY: 
-@GTK_RESPONSE_HELP: 
+@GTK_RESPONSE_NONE: Returned if an action widget has no response id, or if 
+   the dialog gets programmatically hidden or destroyed.
+@GTK_RESPONSE_REJECT: Generic response id, not used by GTK+ dialogs.
+@GTK_RESPONSE_ACCEPT: Generic response id, not used by GTK+ dialogs.
+@GTK_RESPONSE_DELETE_EVENT: Returned if the dialog is deleted.
+@GTK_RESPONSE_OK: Returned by OK buttons in GTK+ dialogs.
+@GTK_RESPONSE_CANCEL: Returned by Cancel buttons in GTK+ dialogs.
+@GTK_RESPONSE_CLOSE: Returned by Close buttons in GTK+ dialogs.
+@GTK_RESPONSE_YES: Returned by Yes buttons in GTK+ dialogs.
+@GTK_RESPONSE_NO: Returned by No buttons in GTK+ dialogs.
+@GTK_RESPONSE_APPLY: Returned by Apply buttons in GTK+ dialogs.
+@GTK_RESPONSE_HELP: Returned by Help buttons in GTK+ dialogs.
 
 <!-- ##### FUNCTION gtk_dialog_new ##### -->
 <para>